<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>YuTori Class: フィルタ機能について</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- 作成： Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "../../search",false,'検索');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">YuTori Class</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>メインページ</span></a></li>
      <li class="current"><a href="../../pages.html"><span>関連ページ</span></a></li>
      <li><a href="../../annotated.html"><span>データ構造</span></a></li>
      <li><a href="../../files.html"><span>ファイル</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="検索" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="headertitle">
<div class="title">フィルタ機能について </div>  </div>
</div>
<div class="contents">
<div class="textblock"><p>YuToriにはクラスフィルタとオブジェクトフィルタの２つのフィルタ機能があります。</p>
<p>フィルタ機能はYuToriの各メソッドの前と後に動作して、YuToriの各動作を変更することができます。 また、本来YuToriにはないメソッドを追加する事もできます。</p>
<p>クラスフィルタはYuToriクラス自体にフィルタをかけるため、既存・新規作成問わずすべてのYuToriに対して動作します。 逆にオブジェクトフィルタは個々のYuToriObjectにフィルタをかけるため、特定のYuToriのみ動作を変更する事ができます。</p>
<h4>フィルタの登録</h4>
<p>フィルタの登録には、regClassFilter、またはregObjectFilterメソッドを使います。 regClassFilterはstaticメソッドですので、インスタンスがなくてもYuTori::regClassFilter()で呼び出す事が可能です。</p>
<p>同様に、登録解除にはunregClassFilter、unregObjectFilterを使います。</p>
<p>メソッドの使用方法は各メソッドのドキュメントを参照してください。 なお、フィルタは登録順に動作します。</p>
<h4>フィルタの構造</h4>
<p>フィルタにはオブジェクトのみ使用できます。 YuToriは各メソッドが動作する前に、フィルタに対して「before+メソッド名」のメソッドを検索します。 例えば、getメソッド動作時にはbeforeGetメソッドを検索、となります。</p>
<p>メソッドの動作後に検索されるフィルタメソッドは「after+メソッド名」となります。</p>
<p>beforeメソッドに渡される引数は、そのYuTori自体のインスタンスとなります。 YuToriはメソッド実行時にargsという配列のプロパティを持っており、これを使用する事で本来のメソッドに渡された引数を参照することができます。 また、プロパティですので値を書き換えることで本来のメソッドに渡す引数を変更する事もできます。 afterメソッドの場合も同様にYuToriのインスタンスが渡されます。 この段階でもargsは残っていますが、メソッドは実行済みなので引数を変える事に意味はありません。 代わりに、methodResultというプロパティにメソッドの実行結果が入っていますので、これを書き換える事で実行結果を変更する事ができます。</p>
<p>なお、staticメソッドに対してフィルタをかけることはできませんので注意してください。</p>
<p>メソッドを追加する方法については、そのままbeforeもafterも付けずにメソッドを記述する事で実現されます。 この場合でも、渡される引数はYuToriのインスタンスのみとなります。</p>
<p>なお、フィルタにマジックメソッド__call()を記述している場合、この__call()にbefore、after、追加すべてのメソッドが一度渡されます。 全メソッドで利用したいフィルタがある場合、これを利用するとよいでしょう。</p>
<h4>フィルタ動作の停止</h4>
<p>オブジェクトフィルタ、クラスフィルタ共に登録したものがすべて実行されますが、フィルタメソッド内でYuTori::stopFilter()を実行した場合、以後のフィルタは動作しません。 同様に、YuTori::stopMethod()を実行した場合、本来のメソッド自体も実行されずに終了します。 その際にメソッドの戻り値を設定したい場合は、第一引数として渡されるYuToriインスタンスのmethodResultプロパティに値を設定してください。</p>
<p>なお、当然ですがstopMethodメソッドはafterメソッドでは使用できません。 </p>
</div></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>全て</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>データ構造</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>関数</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>変数</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address class="footer"><small>YuTori Classに対してMon May 21 2012 00:22:17に生成されました。&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
